home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / sound / vdigit.zip / VOICEKIT.DOC < prev    next >
Text File  |  1989-06-24  |  31KB  |  615 lines
  1.                Digitized Voice Programmer's Toolkit for the PC
  2.                -----------------------------------------------
  3.  
  4.                                Version 1.0
  5.  
  6.                   Copyright (c) 1988,1989, Farpoint Software
  7.  
  8.        *   *   *   *   *   *   *   *   *   *   *   *   *   *   *   *   *
  9.  
  10.  
  11.   **************************************************************************
  12.   *                                                                        *
  13.   *  To those of you who have HIDI.ARC and/or DIGITS.ARC, welcome back.    *
  14.   *  This new release will serve as a major upgrade to things you already  *
  15.   *  have.                                                                 *
  16.   *                                                                        *
  17.   **************************************************************************
  18.  
  19.  
  20. Introduction
  21. ------------
  22.  
  23. This toolkit is a combination of software and hardware designed for the
  24. purpose of mechanizing and simplifying the process by which programmers may
  25. create digitized voice recordings, store them on disk, edit the voice data
  26. files, and incorporate digitized voice playback into their own high-level
  27. language programs.
  28.  
  29. The recording of digitized voice requires a small, inexpensive hardware device
  30. to be built. Schematics and printed circuit board layout files are provided
  31. for this device.
  32.  
  33. Playback of the digitized voice, however, requires NO SPECIAL HARDWARE. The
  34. sound is produced with the built-in speaker provided in nearly all PC's and
  35. PC-compatible machines. This means that programs may be written for general
  36. distribution which will play voice messages on the user's machine as it
  37. exists.
  38.  
  39. Here is a list of the major features of the current software package:
  40.  
  41.   (1) Operates under the DOS environment.
  42.   (2) Provides a full set of voice record/playback control routines which
  43.       are directly callable from many high-level languages including C
  44.       and Pascal. They are also of course callable from assembly language.
  45.   (3) All voice operations proceed IN THE BACKGROUND. The control routines
  46.       return to the caller immediately, and voice playback occurs
  47.       simultaneously with the continuing execution of the main program.
  48.       The main program may call a status routine at any time to check on
  49.       the progress of the voice playback.
  50.   (4) There are no length limitations on either the size of the memory
  51.       buffers or the size of the voice data files on disk other than the
  52.       physical limits of the machine itself. 64k is not a special number.
  53.   (5) A sophisticated voice data file editor is provided. This gives the
  54.       programmer a set of capabilities similar to those available on a
  55.       conventional tape recorder. Position markers, live overwriting,
  56.       selective erasure, cut-and-paste, and assorted other features make
  57.       the produciton of "refined" voice files an easy task.
  58.   (6) Several short example programs are included, written in both C and
  59.       assembly language, which demonstrate the use of the calls to the
  60.       voice modules. There is even an example of a memory-resident program
  61.       which detects the pressing of the left shift key and plays a short
  62.       voice message when this occurs. (Foreground processing continues
  63.       undisturbed.)
  64.  
  65.  
  66. Shareware Notice
  67. ----------------
  68.  
  69. The Digitized Voice Programmer's Toolkit is released as Shareware. This is
  70. copyrighted material; it is NOT "free software". You are permitted to
  71. experiment with this package long enough to determine if it suits your needs,
  72. but if you will be making use of the material in your own programs, then a
  73. license fee of $50 is required. NO PROGRAM WHICH MAKES USE OF THE MATERIALS
  74. IN THIS TOOLKIT MAY BE SOLD COMMERCIALLY OR ON A CONTRACT BASIS UNLESS THE
  75. SELLER HAS PAID THE LICENSE FEE. Please make the check or money order payable
  76. to:
  77.  
  78.         Farpoint Software
  79.         2501 Afton Court
  80.         League City, Texas 77573
  81.  
  82. For convenience, a registration form is included in the file REGISTER.FRM.
  83.  
  84. As a registered user, you will receive updates automatically long before they
  85. are released to BBS's. You will also receive a copy of the source code to the
  86. VDFE editor. Registered users, of course, are given higher priority if
  87. programming assistance or hardware construction assistance is requested.
  88.  
  89. You are granted permission to distribute copies of the Digitized Voice
  90. Programmer's Toolkit, provided that (1) no fee is charged for such copies,
  91. other that a nominal disk duplication fee, (2) these files are distributed
  92. in their original, unmodified form, and (3) ALL the files in the original
  93. archive are included with each copy. (See "List of Files" below.)
  94.  
  95. If you paid a "disk duplication fee" or other such fee to a distributor of
  96. public domain and shareware programs, be aware that the payment of this fee
  97. DOES NOT constitute registration of this Toolkit. Likewise, the payment of a
  98. fee to any Bulletin Board Service for the time required to download this
  99. Toolkit DOES NOT constitute registration. Registration occurs only through
  100. direct interaction with Farpoint Software.
  101.  
  102. If more information is needed, write or contact Alan D. Jones through
  103. Compuserve Information Service at user ID 74030,554.
  104.  
  105.  
  106. List of Files
  107. -------------
  108.  
  109. The files included with the Digitized Voice Programmer's Toolkit are:
  110.  
  111.         BIN2ASM
  112.         BIN2ASM.C
  113.         BIN2ASM.EXE
  114.         EMBEDDED
  115.         EMBEDDED.C
  116.         EMBEDDED.EXE
  117.         EVM.PRE
  118.         EVM.SUF
  119.         EVM.VOI
  120.         LONGTEST.VOI
  121.         README.1ST
  122.         REGISTER.FRM
  123.         RUN_ME.BAT
  124.         TSR
  125.         TSR.ASM
  126.         TSR.EXE
  127.         TSRVM.PRE
  128.         TSRVM.SUF
  129.         TSRVM.VOI
  130.         VDFE.EXE
  131.         VMSCH.HPP
  132.         VOICEKIT.DOC
  133.         VPMOD.ASM
  134.         VPMOD.DOC
  135.         VPMOD.H
  136.         VPMOD.OBJ
  137.         VPTEST
  138.         VPTEST.C
  139.         VPTEST.EXE
  140.         VRMOD.ASM
  141.         VRMOD.DOC
  142.         VRMOD.H
  143.         VRMOD.OBJ
  144.         VRTEST
  145.         VRTEST.C
  146.         VRTEST.EXE
  147.  
  148. If you received the Toolkit with any of the above files missing, please
  149. notify Farpoint Software.
  150.  
  151.  
  152. Description of Voice Subroutine Modules
  153. ---------------------------------------
  154.  
  155. The key software elements in the kit are two assembly language programs,
  156. VRMOD.ASM and VPMOD.ASM, and their assembled OBJ files. These are not stand-
  157. alone programs. They are designed to be linked with other programs to provide
  158. the voice control routines. The calls associated with recording are in
  159. VRMOD, and the calls associated with playback are in VPMOD. Any given program
  160. may be linked with either or both of these modules. Typically, a program
  161. designed for general distribution would be linked only with VPMOD, since
  162. recording requires the hardware device.
  163.  
  164. The external hooks to the two modules consist of various "public" procedure
  165. names. All procedures use the Pascal calling convention, since most high-level
  166. language compilers can support this calling method. The Pascal calling
  167. convention has the following meaning:
  168.  
  169.   (1) Procedure names are all caps, and are not preceeded by an underscore.
  170.   (2) Procedures are called with "far" (intersegment) calls.
  171.   (3) Short return values appear in the AX register; long return values
  172.       appear in DX:AX.
  173.   (4) Parameters are pushed onto the stack in left-to-right order; i.e. the
  174.       first parameter in the list is pushed first. If the parameter is a
  175.       doubleword, then the high order word is pushed first.
  176.   (5) The called subroutine is responsible for clearing the parameters from
  177.       the stack upon return.
  178.  
  179. The above list will be of interest primarily to assembly language programmers.
  180. When working in a high-level language, it is necessary only to make sure that
  181. the compiler is using the proper calling method. For C programs, two header
  182. files have been included. They are VRMOD.H and VPMOD.H. At the beginning of
  183. any C program which is to use the voice playback routines, insert the line:
  184.  
  185. #include "vpmod.h"
  186.  
  187. This file contains prototypes of all procedure calls in VPMOD.ASM, declared
  188. in a way